Xamarin.Essentials
Accelerometer data of the acceleration of the device in three dimensional space.
Gets if acceleromter is being monitored.
If monitoring.
Event triggered when reading of sensor changes.
Event triggered when a shake has been detected on the device.
Speed to monitor the sensor.
Start monitoring for changes to acceleromter.
Will throw FeatureNotSupportedException if not supported on device. Will throw ArgumentNullException if handler is null.
Stop monitoring for changes to acceleromter.
Event arguments containing the current reading.
To be added.
To be added.
To be added.
The current values of accelerometer.
The readin.
Data representing the devies' three accelerometers.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Gets the acceleration vector in G's (gravitational force).
Object to compare
If equal to another object
If equal
Other AccelerometerData to compare with.
Compares the underlying Vector3 instances.
True if they are equal, otherwise false.
Get the hash code for object.
The hash code
Left to compare
Right to compare
Equality operator for equals
If equal
Left to check
Right to check
Inequality check
If not equal
To be added.
To be added.
To be added.
Represents information about the application.
Gets the application build number.
The application build number.
Gets the application name.
The application name.
Gets the application package name or identifier.
The package name or identifier.
On android and iOS, this is the application package name. On UWP, this is the application GUID.
Open the settings menu or page for the application.
Gets the application version.
The application version.
Gets the application version.
The application version.
Monitor changes to the atmospheric pressure.
Gets if barometer is actively being monitored.
If barometer is being monitored.
Event triggered when barometer reading changes.
The speed to listen for changes.
Start monitoring for changes to the barometer.
Will throw FeatureNotSupportedException if not supported on device.
Stop monitoring for changes to the barometer.
The current pressure information from the change event.
To be added.
To be added.
To be added.
Gets the current barometer pressure data
Pressure in hPA
Contains the pressure measured by the user's device.
To be added.
To be added.
To be added.
Object to compare
If equal to another object
If equal
Other object to compare
If equal to another object
If equal
Get has code for object.
The hash code.
Left to compare
Right to compare
If equal to another object
If equal
Left to comapre
Right to comapre
If not equal to another object
If not equal
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Methods and properties for battery and charging information of the device.
Platform specific remarks:
- Android: Battery_Stats permission must be set in manifest.
- iOS: Simulator will not return battery information, must be run on device
- UWP: None
Event trigger when battery properties have changed.
Gets the current charge level of the device from 0.0 to 1.0.
Level of charge.
Gets the current energy saver status of the device.
The current status of energy saver mode.
Event that is triggered when energy saver status changes.
Gets the current power source for the device.
Power source, or uknown.
Gets the charging state of the device if it can be determined.
Battery state, or unknown.
Battery changed information.
Returns the current information of the battery.
To be added.
To be added.
To be added.
To be added.
To be added.
Gets the current charge level of the device from 0.0 to 1.0.
Level of charge.
Gets the current power source for the device.
Power source, or unknown
Gets the charging state of the device if it can be determined.
Battery state, or unknown.
To be added.
To be added.
To be added.
How the device and battery are currently being powered or charged.
Power source is an AC Charger.
Power source is the battery and not being charge.
Power source can not be determined.
Power source is a USB port.
Power source is wireless.
The current state of the battery and if it is being charged or full.
Battery is acively being charged by a power source.
Battery is not plugged in and discharging.
Battery is full.
Battery is not charging or discharging, but in an inbetween state.
Battery does not exist on the device.
Battery state could not be determined.
Provides a way to display a web page inside an app.
Uri to launch.
Open the browser to specified uri.
Completed task when browser is launched, but not necessarily closed. Result indicates if launching was successful or not.
Uri to launch.
Open the browser to specified uri.
Completed task when browser is launched, but not necessarily closed. Result indicates if launching was successful or not.
Uri to launch.
How to launch the browser.
Open the browser to specified uri.
Completed task when browser is launched, but not necessarily closed. Result indicates if launching was successful or not.
Uri to launch.
Launch options for the browser.
Open the browser to specified uri.
Completed task when browser is launched, but not necessarily closed. Result indicates if launching was successful or not.
Uri to launch.
How to launch the browser.
Open the browser to specified uri.
Completed task when browser is launched, but not necessarily closed. Result indicates if launching was successful or not.
Uri to launch.
Launch options for the browser.
Open the browser to specified uri.
Completed task when browser is launched, but not necessarily closed. Result indicates if launching was successful or not.
Launch type of the browser.
Recommended to use the SystemBrowser as it is the default and falls back to UriLauncher.
Use the default external launcher to open the browser outside of the app.
Launch the optimized system browser and stay inside of your application. (Chrome Custom Tabs and SFSafariViewController).
Optional setting to open the browser with.
These settings do not apply to all operation systems. Check documentation for more information.
Default constructor.
Launch type of the browser.
The launch type.
Preferred color of the controls on the browser.
Gets the color for controls.
Preferred color of the background toolbar.
Gets the toolbar color.
Preferred mode for the title display.
Gets the title display mode.
Mode for the title.
Uses the system default showing it.
Hide the title.
Show the title.
Provides a way to work with text on the device clipboard.
Returns any text that is on the clipboard.
Returns text that is on the clipboard, or null if there is none.
Gets a value indicating whether there is any text on the clipboard.
The text to put on the clipboard.
Sets the contents of the clipboard to be the specified text.
Returns text that is on the clipboard, or null if there is none.
This method returns immediately and does not guarentee that the text is on the clipboard by the time this method returns
Contains several helper methods to convert System.Drawing.Color
A string value similar to the syntax used in HTML, eg "00FF00". Alpha can optionally be specified as the first pair of the characters ("CC00FF00").
Creates a new Color from a Hex string.
A color from the Hex string.
The hue of the color from 0-360.
The saturation of the color from 0-100.
The luminosity of the color from 0-100.
Creates a new Color from hue, saturation, and lightness.
A new color from the Hsla.
The hue of the color from 0-360.
The saturation of the color from 0-100.
The luminosity of the color from 0-100.
The alpha of the color from 0-255.
Creates a new Color from hue, saturation, luminosity, and alpha.
A new color from the Hsla.
A single value representing argb.
Creates a new Color from an UInt.
A new color from the Uint
Extension methods for System.Drawing.Color
The color to add luminosity to.
The delta to add to the current luminosity.
Adds luminosity to the existing color
The new color.
The current color to manipulate.
The percentage from 0-1f
Multiplies the current alpha by a percentage (0-1f)
The new color.
To be added.
To be added.
To be added.
To be added.
The color to use as a base.
Converts the color to the platform specific color.
The platform color.
The color to use as a base.
Converts the color to the platform specific color.
The platform color.
The color to use as a base.
Converts the color to the platform specific color.
The platform color.
The color to use as a base.
Converts the color to the system specific color.
The system color.
The color to use as a base.
Converts the color to the system specific color.
The system color.
The color to use as a base.
Converts the color to the system specific color.
The system color.
The color to use as a base.
Converts the color to a UInt representation.
The UInt representation.
The color to use as a base.
The alpha to set 0-255.
Creates a new color based on this color, but with a new alpha (0-255).
The new color.
The color to use as a base.
The hue to set 0-360.
Creates a new color based on this color, but with a new hue (0-360).
The new color.
The color to use as a base.
The luminosity to set 0-100.
Creates a new color based on this color, but with a new luminosity (0-100).
The new color.
The color to use as a base.
The saturation to set 0-100.
Creates a new color based on this color, but with a new saturation (0-100).
The new color.
Monitor changes to the orientation of the user's device.
Gets if compass is actively being monitored.
If compass is being monitored.
Event triggered when compass reading changes.
Determines if the calibration screen should be displayed.
Gets or sets if this should be displayed when started.
Only available on iOS
The speed to monitor for changes.
Start monitoring for changes to the compass.
Will throw FeatureNotSupportedException if not supported on device. Will throw ArgumentNullException if handler is null.
The speed to monitor for changes.
Whether or not to apply a moving average filter (only used on Android).
Start monitoring for changes to the compass.
Will throw FeatureNotSupportedException if not supported on device. Will throw ArgumentNullException if handler is null.
Stop monitoring for changes to the compass.
Event arguments when compass reading changes.
To be added.
To be added.
To be added.
Gets the current reading.
The reading.
Contains the orientation of the user's device.
To be added.
To be added.
To be added.
Object to compare
If equal to another object
If equal
Other AccelerometerData to compare with.
Compares the underlying doubles.
True if they are equal, otherwise false.
Get the hash code for object.
The hash code
The heading (measured in degrees) relative to magnetic north.
The magnetic north heading.
Left to compare
Right to compare
Equality operator for equals
If equal
Left to check
Right to check
Inequality check
If not equal
To be added.
To be added.
To be added.
Describes the type of connection the device is using.
The bluetooth data connection.
The mobile/cellular data connection.
The ethernet data connection.
Other unknown type of connection.
The WiFi data connection.
Connectivity and networking helpers.
Gets the active connectivity types for the device.
List of all connection profiles.
Can throw PermissionException on Android if ACCESS_NETWORK_STATE is not set in manifest.
Event that is triggered when a network access or profile has changed.
Can throw PermissionException on Android if ACCESS_NETWORK_STATE is not set in manifest.
Gets the current state of network access. Does not guarantee full access to the internet.
The current network access state.
Can throw PermissionException on Android if ACCESS_NETWORK_STATE is not set in manifest.
The current connectivity information from the change event.
To be added.
To be added.
To be added.
To be added.
Gets the active connectivity types for the device.
List of all connection profiles.
Gets the current state of network access. Does not guarantee full access to the internet.
The current network access state.
To be added.
To be added.
To be added.
Represents information about the device screen.
Gets or sets if the screen shold be kept on.
If the screen keep on is set.
Gets the main screens display info.
The main screen display info.
Event that is triggered when the main display info changes.
The idiom (form factor) of the device.
To be added.
Creates a new device idiom.
To be added.
To be added.
Gets the desktop idiom.
To be added.
To be added.
To be added.
Checks the equality of the idiom.
To be added.
To be added.
To be added.
Checks the equality of the idiom.
To be added.
To be added.
Gets the hash code for the idom.
To be added.
To be added.
To be added.
To be added.
Checks the equality of the idiom.
To be added.
To be added.
To be added.
To be added.
Checks the equality of the idiom.
To be added.
To be added.
Gets the phone idiom.
To be added.
To be added.
Gets the tablet idiom.
To be added.
To be added.
String representation of the idiom.
To be added.
To be added.
Gets the TV idiom.
To be added.
To be added.
Gets the unknown idiom.
To be added.
To be added.
Gets the watch idiom.
To be added.
To be added.
Represents information about the device.
Gets the type of device the application is running on.
The device type.
Gets the idiom of the device.
The idiom.
Gets the manufacturer of the device.
Device manufacturer.
Gets the model of the device.
Device model.
Gets the name of the device.
The name of the device (often specified by the user).
Gets the platform or operating system of the device.
The platform of device.
Gets the version of the operating system.
The device operating system.
Gets the version of the operating system.
The version of the operating system.
The device platform that the application is running on.
Gets the Android platform.
To be added.
To be added.
To be added.
Creates a new Device Platform.
To be added.
To be added.
To be added.
Checks the equality of the platform.
To be added.
To be added.
To be added.
Checks the equality of the platform.
To be added.
To be added.
Gets the hash code of the platform.
To be added.
To be added.
Gets the iOS platform.
To be added.
To be added.
To be added.
To be added.
Checks the equality of the platform.
To be added.
To be added.
To be added.
To be added.
Checks the equality of the platform.
To be added.
To be added.
The string representation of the platform.
To be added.
To be added.
Gets the unknown platform.
To be added.
To be added.
Gets the UWP platform.
To be added.
To be added.
Various types of devices.
The device is a physical device, such as an iPhone, Android tablet or Windows desktop.
To be added.
The device is virtual, such as the iOS simulators, Android emulators or Windows emulators.
Represents information about the screen.
To be added.
To be added.
To be added.
To be added.
To be added.
Main constructor for Display Information
To be added.
Gets a value representing the screen density.
The screen density.
Object to compare.
If equal to another object.
If equal.
The other display info to compare.
If equal to another object.
If equal.
Gets the hash code for object.
The hash code.
Gets the height of the screen for the current orientation.
The height in pixels.
Left to compare.
Right to compare.
If equal to another object.
If equal
Left to compare
Right to compare
If not equal to another object.
If not equal
Gets the orientation of the device.
The orientation.
Gets the rotation from the designated orientation.
The rotation
String representation of information.
String information about display info.
Gets the width of the scrreen for the current orientation.
The width in pixels.
Main display information event arguments.
To be added.
Main constructor for event args.
To be added.
Gets the current display info for the main display.
To be added.
To be added.
Display Orientation
Display is in landscape.
Display is in portrait.
Unknown display orientation.
Display rotation.
Rotated 0 degrees.
Rotated 180 degrees.
Rotated 270 degrees.
Rotated 90 degrees.
Unknown display rotation.
Distance Unit for use in conversion.
Kilometers
Miles
Provides an easy way to allow the user to send emails.
Opens the default email client to allow the user to send the message.
The email message.
Opens the default email client to allow the user to send the message.
The email subject.
The email body.
The email recipients.
Opens the default email client to allow the user to send the message with the provided subject, body and recipients.
Email file attachment.
Full path and filename to file.
Email attachment from filename.
Existing file.
Email attachment from existing file.
Full path and filename to file.
Explicit content type of file.
Gets or sets the intended name of the file to be shared.
Represents various types of email body formats.
The email message body is HTML (not supported on UWP).
The email message body is plain text.
Represents a single email message.
Creates a new instance of EmailMessage.
The email subject.
The email body.
The email's recipients.
Creates a new instance of EmailMessage with the specified subject, body and recipients.
Gets or sets a list of file attachments.
Gets or sets the email's BCC recipients.
Gets or sets the email's body.
Gets or sets a value indicating whether the message is in plain text or HTML (not supported on UWP).
Gets or sets the email's CC recipients.
Gets or sets the email's subject.
Gets or sets the email's recipients.
Status of energy saver on the device.
Energy save is off
Energy saver is on
Status of energy saver is unknown.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Exception that occurs when an attempt is made to use a feature on a platform that does not support it.
Creates a new instance of FeatureNotSupportedException.
The exception message.
Creates a new instance of FeatureNotSupportedException with the specified message.
The exception message.
The inner exception.
Creates a new instance of FeatureNotSupportedException with the specified message and inner exception.
A representation of a file and its content type.
An existing FileBase instance to use.
FileBase from an existing instance.
Gets or sets the file's content type.
Gets the full path and filename.
Android FileProvider implementation for creating Content URIs to share files with other applications.
Default constructor.
Gets or sets the temporary location for file sharing.
The default is to prefer external and fallback to internal.
Location to save temporary files to for sharing.
External storage or cache only.
Internal cache only,
Prefer external and fall back to internal if unavailable.
Provides an easy way to access the locations for device folders.
Gets the location where app data can be stored.
The location where app data can be stored.
This location usually is not visible to the user, and is backed up.
Gets the location where temporary data can be stored.
The location where temporary data can be stored.
This location usually is not visible to the user, is not backed up, and may be cleared at any time.
the name of the file to load from the app package.
Opens a stream to a file contained withing the app package.
Returns a stream to the file.
Turn the Flashlight / Torch / Lamp On and Off.
Turns the Flashlight Off.
Turns the Flashlight On.
Easily convert between geographic coordinated and place names.
Address to retrieve the lcoation for.
Retrieve location for a given address.
List of locations that best match the address or null if none found.
Location to find placemarks for.
Retrieve placemarks for a given location.
List of placemarks or null if no placemarks are found.
Latitude of the location.
Longitude of the location.
Retrieve location for a given address.
List of placemarks or null if no placemarks are found.
Provides a way to get the current location of the device.
Returns the last known location of the device.
Returns the location.
This location may be a recently cached location.
Returns the current location of the device.
Returns the location.
The criteria to use when determining the location of the device.
Returns the current location of the device using the specified criteria.
Returns the location.
The criteria to use when determining the location of the device.
A token for cancelling the operation.
Returns the current location of the device using the specified criteria.
Returns the location.
Represents levels of accuracy when determining location.
Represents the best accuracy, using the most power to obtain and typically within 10 meters.
Represents default accuracy (Medium), typically within 30-500 meters.
Represents high accuracy, typically within 10-100 meters.
Represents low accuracy, typically within 300-3000 meters.
Represents the lowest accuracy, using the least power to obtain and typically within 1000-5000 meters.
Represents medium accuracy, typically within 30-500 meters.
Represents the criteria for a location request.
Creates a new instance of GeolocationRequest.
The desired accuracy.
Creates a new instance of GeolocationRequest with the specified accuracy.
The desired accuracy.
The request timeout.
Creates a new instance of GeolocationRequest with the specified accuracy and timeout.
Gets or sets the desired accuracy of the resulting location.
The desired accuracy of the location.
Gets or sets the location request timeout.
The location request timeout.
To be added.
To be added.
To be added.
Gyroscope data of the rotation around the device's three primary axis.
Gets if gyro is being monitored.
If monitoring.
Event triggered when reading of sensor changes.
Speed to monitor sensor.
Start monitoring for changes to gyro.
Will throw FeatureNotSupportedException if not supported on device. Will throw ArgumentNullException if handler is null.
Stop monitoring for changes to gyro.
Event arguments containing the current reading.
To be added.
To be added.
To be added.
Gets the reading of the gyro.
The reading.
Gyroscope information.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Gets the angular velocity vector in radians per second.
Object to compare
If equal to another object
If equal
Other GyroscopeData to compare with.
Compares the underlying Vector3 instances.
True if they match, otherwise false.
Get the hash code for object.
The hash code
Left to compare
Right to compare
Equality operator for equals
If equal
Left to check
Right to check
Inequality check
If not equal
To be added.
To be added.
To be added.
Launches an application specified by the passed uri.
Has to be a valid System.Uri
string uri scheme
Queries if device supports opening the uri scheme
True if opening is supported, otherwise false
May throw System.UriFormatException if uri is malformed
uri scheme
Queries if device supports opening the uri scheme
True if opening is supported, otherwise false
May throw System.UriFormatException if uri is malformed
string uri scheme
Launches the app specified by the uri scheme
May throw System.UriFormatException if uri is malformed. Verify if the uri scheme is supported before calling this method
uri scheme
Launches the app specified by the uri scheme
May throw System.UriFormatException if uri is malformed. Verify if the uri scheme is supported before calling this method
Represents a specific geographical, political, or cultural region.
Country name or code.
This value may vary between platforms.
Unique Id of the Locale.
Language name or code.
This value may vary between platforms.
Display name of the Locale.
The latitude, longitude, and time information reported by the device.
Constructor for a location.
Location to copy values from.
Constructor for a location.
Default latitude for location.
Default longitude for location.
Constructor for a location.
Default latitude for location.
Default longitude for location.
Timestamp for the location (Utc based).
Constructor for a location.
Gets or sets the accuracy (in meters) of the location.
The location accuracy.
Gets the Altitude, if available in meters above sea level.
Altidude of location if available.
Returns 0 or no value if not available.
Start location to calculate from.
End location to calculate from.
Units to return.
Calculate distance between two locations.
Distance between two locations in the unit selected.
Start latitude to calculate from.
Start longitude to calculate from.
End location to calculate from.
Unit to return.
Calculate distance between two locations.
Distance calculated.
Start location to calculate from.
End latitude to calculate from.
End longitude to calculate from.
Unit to use.
Calculate distance between two locations.
Distance calculated.
Start latitude to calculate from.
End latitude to calculate from.
Start longitude to calculate from.
End longitude to calculate from.
Units to return.
Calculate distance between two locations.
Distance between two locations in the unit selected.
Degrees relative to true north.
0..360 in degrees relative to true north. null if unavailable.
Inform if location is from GPS or from Mock.
True if is from Mock and False if from GPS.
Gets or sets the latitude of location.
Latitude of the location.
Gets or sets the longitude of location.
Longitude of the location.
Speed in meters per second.
Speed measured by the device..
Gets or sets the timestamp of the location.
UTC timestamp.
To be added.
To be added.
To be added.
Location Extensions
Start location to calculate from.
End location to calculate from.
Units to use during calculation.
Extension to calculate distance from location to another location.
Distance in units fro two locations.
Start location to calculate from.
End latitude to calculate from.
End longitude to calculate from.
Units to use.
Extension to calculate distance from location to another location.
Distance calculated.
Location to open to.
Open maps to this location.
Task to wait.
Location to open to.
Options to use.
Open maps to this location.
Task to wait.
Detect device's orentation relative to Earth's magnetic field in microteslas (µ).
Gets if magnetometer is being monitored.
If monitoring.
Event triggered when reading of sensor changes.
Speed to get sensor information.
Start monitoring for changes to magnetometer.
Will throw FeatureNotSupportedException if not supported on device. Will throw ArgumentNullException if handler is null.
Stop monitoring for changes to magnetometer.
Event arguments containing the current reading.
To be added.
To be added.
To be added.
Gets the reading of the magnetometer.
The reading.
Data for magnetometer changes.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Object to compare
If equal to another object
If equal
Other MagnetometerData to compare with.
Compares the underlying Vector3 instances.
True if they match, otherwise false.
Get the hash code for object.
The hash code
Gets the magnetic field vector in microteslas (µ).
Left to compare
Right to compare
Equality operator for equals
If equal
Left to check
Right to check
Inequality check
If not equal
To be added.
To be added.
To be added.
Main Thread helpers.
Main Thread helpers.
Action to execute.
Invokes an action on the main thread of the application.
Gets if it is the current main UI thread.
If main thread.
Map helpers to open a route to specified places via default platforms maps implementation.
Location to open on maps.
Open the installed application to a specific location.
Task to be completed.
Placemark to open on maps.
Open the installed application to a specific placemark.
Task to be completed.
Latitude to open to.
Longitude to open to.
Open the installed application to a specific location.
Task to be completed.
Location to open maps to.
Launch options to use.
Open the installed application to a specific location with launch options.
Task to be completed.
Placemark to open maps to.
Launch options to use.
Open the installed application to a specific placemark with launch options..
Task to be completed.
Latitude to open to.
Longitude to open to.
Launch options to use.
Open the installed application to a specific location.
Task to be completed.
To be added.
To be added.
To be added.
To be added.
Name of destination to display to user.
Gets the name.
The navigation mode to use.
Gets the navigation mode.
Represents various modes of navigation.
Default is none.
Bicycle route mode.
The default navigation mode on the platform.
Car route mode.
No navigation mode for map.
Transit route mode.
Walking route mode.
Various states of the connection to the internet.
Limited internet access.
Local and Internet access.
Local network access only.
No connectivity.
The state of the connectivity is not known.
Exception that occurs when executed from a reference assembly. This usually means that the NuGet was not installed into the app project.
Default constructor.
Device orientation (quaternion) relative to magnetic fields.
Gets of currently monitoring the sensor.
If monitoring.
Event triggered when reading of sensor changes.
Sensor speed to use.
Starts monitoring orientation sensor with specific speed.
Stops monitoring.
Orientation event args when reading changes.
To be added.
To be added.
To be added.
Gets the reading when it changes.
The current Reading
Sensor data for orientation.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Object to compare
If equal to another object
If equal
Other OrientationSensorData to compare with.
Compares the underlying Quaternion instances.
True if they match, otherwise false.
Get the hash code for object.
The hash code
Left to compare
Right to compare
Equality operator for equals
If equal
Left to check
Right to check
Inequality check
If not equal
Gets the current orientation that represents a Quaternion.
Gets the current orientation
To be added.
To be added.
To be added.
Exception that occures when calling an API that requires a specific exception
Permission that is required.
Constructor with permission information.
Open the platform phone dialer to place a call.
Phone number to initialize the dialer with. Example 15555555555
Open the phone dialer to a specific phone number.
Throws ArgumentNullException if number is not valid.Throws FeatureNotSupportedException if placing phone call is not supported on the device.
User-friendly description of a geographic coordinate. This contains information such as the name of the place, its address, and other information.
Default constructor for placemark.
Placemark to copy.
Constructor to create a deep copy.
Gets or sets the administrative area name of the address, for example, "CA", or null if it is unknown.
The admin area.
Gets or sets the country ISO code.
The country ISO code.
Gets or sets the country name.
The country name.
Gets or sets the feature name.
The feature name.
Gets or sets the city or town.
The city or town of the locality.
Gets or sets the location of the placemark.
The location of the palcemark.
Gets or sets the postal code.
The postal code.
Gets or sets the sub-administrative area name of the address, for example, "Santa Clara County", or null if it is unknown.
The sub-admin area.
Gets or sets the sub locality.
The sub locality.
Gets or sets optional info: sub street or region.
The sub thoroughfare.
Gets or sets the street name.
The street name.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Platform specific helpers.
Application to initialize with.
Initialize Xamarin.Essentials with Android's application class.
Activity to use for initialization.
Bundle of the activity.
Initialize Xamarin.Essentials with Android's activity and bundle.
Get or sets the map API key.
The current key for maps.
Needed only for UWP and can be generated from Bing Maps.
The requestCode from the corresponding overridden method in an activity.
The permissions from the corresponding overridden method in an activity.
The grantResults from the corresponding overridden method in an activity.
Pass permission request results from an activity's overridden method to the library for handling internal permission requests.
Extension methods for Point.
The point to convert.
Converts the point ot the platform representation.
The converted point.
The point to convert.
Converts the point ot the platform representation.
The converted point.
The point to convert.
Converts the point ot the platform representation.
The converted point.
The point to convert.
Converts the point ot the platform representation.
The converted point.
The point to convert.
Converts the point ot the platform representation.
The converted point.
The point to convert.
Converts the point ot the platform representation.
The converted point.
The point to convert.
Converts the point ot the system representation.
The converted point.
The point to convert.
Converts the point ot the system representation.
The converted point.
The point to convert.
Converts the point ot the system representation.
The converted point.
The point to convert.
Converts the point ot the system representation.
The converted point.
The point to convert.
Converts the point ot the system representation.
The converted point.
The point to convert.
Converts the point ot the system representation.
The converted point.
A class to interact with the preferences/settings of the native platform.
Each platform uses the platform provided native APIs for storing application/user preferences:
-
iOS: NSUserDefaults
-
Android: SharedPreferences
-
UWP: ApplicationDataContainer
Clears all keys and values.
Shared container name.
Clears all keys and values.
Preference key.
Checks the existence of a given key.
Returns true if the key exists.
Preference key.
Shared container name.
Checks the existence of a given key.
Returns true if the key exists.
Preference key.
Default value to return if the key does not exist.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Shared container key.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Shared container key.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Shared container key.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Shared container key.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Shared container key.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Shared container key.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Shared container key.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Removes a key and its associated value if it exists.
Preference key.
Shared container name.
Removes a key and its associated value if it exists.
Preference key.
Preference value.
Sets a value for a given key.
Preference key.
Preference value.
Sets a value for a given key.
Preference key.
Preference value.
Sets a value for a given key.
Preference key.
Preference value.
Sets a value for a given key.
Preference key.
Preference value.
Sets a value for a given key.
Preference key.
Preference value.
Sets a value for a given key.
Preference key.
Preference value.
Sets a value for a given key.
Preference key.
Preference value.
Shared container name.
Sets a value for a given key.
Preference key.
Preference value.
Shared container name.
Sets a value for a given key.
Preference key.
Preference value.
Shared container name.
Sets a value for a given key.
Preference key.
Preference value.
Shared container name.
Sets a value for a given key.
Preference key.
Preference value.
Shared container name.
Sets a value for a given key.
Preference key.
Preference value.
Shared container name.
Sets a value for a given key.
Preference key.
Preference value.
Shared container name.
Sets a value for a given key.
Extension methods for Rectangle.
The base rectangle to convert.
Convert to platform rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to platform rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to platform rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to platform rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to platform rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to platform rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to system rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to system rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to system rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to system rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to system rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to system rectangle.
The converted rectangle.
Provides simple secure storage for key/value pairs.
Each platform uses the platform provided native API's for storing data securely:
-
iOS: Data is stored in KeyChain. Additional information on SecAccessible at:
-
Android: Encryption keys are stored in KeyStore and encrypted data is stored in a named shared preference container (PackageId.Xamarin.Essentials).
-
UWP: Data is encrypted with DataProtectionProvider and stored in a named ApplicationDataContainer (with a container name of ApplicationId.Xamarin.Essentials).
NOTE: On Android devices running below API 23 (6.0 Marshmallow) there is no AES available in KeyStore. As a best practice this API will generate an RSA/ECB/PKCS7Padding key pair stored in KeyStore (the only type supported in KeyStore by these lower API levels), which is used to wrap an AES key generated at runtime. This wrapped key is stored in Preferences.
iOS: Default SecAccessible to use for all Get/Set calls to KeyChain. Default value is AfterFirstUnlock.
The SecAccessible to use for all KeyChain access.
For more information see:
Storage Key.
Gets the decrypted value for a given Key.
Decrypted string.
The key to remove.
Removes the encrypted key/value pair for the given key.
Returns true if the key value pair was removed.
Removes all of the stored encrypted key/value pairs.
Storage Key.
The value to be encrypted.
Stores the value which is encrypted, for a given Key.
Storage Key.
The value to be encrypted.
The KeyChain accessibility to create the encrypted record with.
Stores the value which is encrypted, for a given Key. iOS override to specify SecAccessible for the KeyChain.
Sensor speed to monitor for changes.
To be added.
Get the sensor data as fast as possible.
Rate suitable for games.
Rate suitable for general user interface.
Share data such as text and uris to other applications.
Text to share.
Show the share user interface to share text.
Task when completed.
File request to share.
Show the user interface to share a file.
Task when completed.
Share request with options.
Show the share user interface to share text or uri.
Task when completed.
Text to share.
Title for the share user interface.
Show the share user interface to share text with a title.
Task when completed.
A file to be shared.
The full path and filename.
File to be shared.
Existing file to be shared.
Shares an existing file.
Full path and filename.
Explicit content type of the file.
Gets or sets the intended name of the file to be shared.
File name and extension of original file will be used by default.
Standard request for sharing a file to another application.
Default constructor.
Existing file.
Share request with an existing file.
Existing file.
Share request with an existing file.
Title to use on the share user interface.
Existing file.
Share request with an existing file.
Title to use on the share user interface.
Existing file.
Share requerst with an existing file.
Gets or sets the file to share.
Gets or sets the title to use on the share user interface
Standard request for sharing text to other applications.
Default constructor.
Text to share.
Share request with text.
Text to share.
Title for share user interface.
Share request with text and title.
Gets or sets the subject that is sometimes used for applications such as mail clients.
The subject.
Gets or sets the main text or message to share.
The main text.
Gets or sets the title to use on the share user interface.
The title to display.
Gets or sets a valid Uri to share.
The uri that will be shared.
This must be a valid uri or an exception will be thrown.
Extension methods for Size.
Base size to convert.
Convert to platform Size.
Converted size.
Base size to convert.
Convert to platform Size.
Converted size.
Base size to convert.
Convert to platform Size.
Converted size.
Base size to convert.
Convert to platform Size.
Converted size.
Base size to convert.
Convert to platform Size.
Converted size.
Base size to convert.
Convert to platform SizeF.
Converted size.
Base size to convert.
Convert to system Size.
Converted size.
Base size to convert.
Convert to system Size.
Converted size.
Base size to convert.
Convert to system Size.
Converted size.
Base size to convert.
Convert to system SizeF.
Converted size.
Base size to convert.
Convert to system SizeF.
Converted size.
Base size to convert.
Convert to system SizeF.
Converted size.
Provides an easy way to allow the user to send SMS messages.
Opens the default SMS client to allow the user to send the message.
The message to send.
Opens the default SMS client to allow the user to send the message.
Represents a single SMS message.
Creates a new instance of SmsMessage
Content of the message
Recipients to receive the message.
Creates a new instance of SmsMessage
Content of the message
Recipient to receive the message.
Creates a new instance of SmsMessage
Gets the body of the message.
Gets the recipient of the message.
Text-to-speech options.
Gets or Sets a specific Locale to use with text to speech.
The Language property should match a Locale value returned by GetLocalesAsync().
The pitch to use when speaking.
This value should be between 0f and 2.0f.
The volume to use when speaking.
This value should be between 0f and 1.0f.
Speak text to Speech
Gets a list of Locales supported by Text to Speech.
The text to speak..
Optional cancellation token to stop speaking.
Speaks the given text with default options.
The text to speak.
The options to use for speaking.
Optional cancellation token to stop speaking.
Speaks the given text with the specified options.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Provides an easy way to track an app's version on a device.
Gets the collection of build numbers of the app that ran on this device.
Gets the current build of the app.
Gets the current version number of the app.
Gets the build number of first version of the app that was installed on this device.
Gets the version number of the first version of the app that was installed on this device.
Gets a value indicating whether this is the first time this app has ever been launched on this device.
The build number.
Determines if this is the first launch of the app for a specified build number.
Returns true if this is the first launch of the app for the specified build number; otherwise false.
Gets a value indicating if this is the first launch of the app for the current build number.
Gets a value indicating if this is the first launch of the app for the current version number.
The version number.
Determines if this is the first launch of the app for a specified version number.
Returns true if this is the first launch of the app for the specified version number; otherwise false.
Gets the build number for the previously run version.
Gets the version number for the previously run version.
Starts tracking version information.
Gets the collection of version numbers of the app that ran on this device.
Provides an easy way to make the device vibrate.
Cancel any current vibrations.
Vibrate the device fo 500ms.
The number of milliseconds to vibrate for.
Vibrate the device for the specified number of milliseconds in the range [0, 5000].
On iOS, the device will only vibrate for 500ms, regardless of the value specified.
The time to vibrate for.
Vibrate the device for the specified time in the range [0, 5000]ms.
On iOS, the device will only vibrate for 500ms, regardless of the value specified.